Align webpack's outputPath with the whole app #1194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We hard-code webpack's output path to be the "assets" subdirectory of the built app (which appears as "./dist/assets" after you run a build). This is needlessly confusing and limiting, because webpack's view of the world doesn't match what the app author actually writes. Mostly this doesn't matter when people are using all the defaults, but if they wanted to customize (for example) the location of the generated chunks they can't escape the assets subdir. This PR fixes this problem by setting webpack's `output.path` to the root of the (output) ember app (meaning the "./dist" subdir in a typical build), and making corresponding adjustments to `output.filename` and `output.chunkFileName` so that we're still producing the same files by default, but they're now addressed relative to the whole app.
| chunkFilename: `chunk.[chunkhash].js`, | ||
| publicPath: publicAssetURL + 'assets/', | ||
| path: join(this.outputPath), | ||
| filename: `assets/chunk.[chunkhash].js`, |
There was a problem hiding this comment.
do we have existing tests to assert these files are created in this folder?
There was a problem hiding this comment.
Tests likethese are directly inspecting the output files.
And the various tests/scenarios are ensuring that these files actually execute.
NullVoxPopuli
approved these changes
Apr 18, 2022
| webpackConfig: Configuration; | ||
|
|
||
| // the base public URL for your assets in production. Use this when you want | ||
| // to serve all your assets from a different origin (like a CDN) than your | ||
| // actual index.html will be served on. | ||
| // | ||
| // This should be a URL ending in "/". | ||
| // | ||
| // For example: |
There was a problem hiding this comment.
thanks for adding additional docs + examples!
SergeAstapov
approved these changes
Apr 20, 2022
ef4
added a commit
that referenced
this pull request
May 24, 2022
In #1194 we adjusted the webpack outputPath and made a compensating adjustment to the default JS chunk names so they would still end up in the same place. But we neglected to make a compensating change to the default chunk naming for production CSS chunks. This caused the chunks to unintentionally move up one level in the directory hierarchy. This doesn't break anything, but it's inconsistent. This PR puts them back inside "assets" like before.
wondersloth
pushed a commit
to wondersloth/embroider
that referenced
this pull request
Jun 1, 2022
In embroider-build#1194 we adjusted the webpack outputPath and made a compensating adjustment to the default JS chunk names so they would still end up in the same place. But we neglected to make a compensating change to the default chunk naming for production CSS chunks. This caused the chunks to unintentionally move up one level in the directory hierarchy. This doesn't break anything, but it's inconsistent. This PR puts them back inside "assets" like before.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We hard-code webpack's output path to be the "assets" subdirectory of the built app (which appears as "./dist/assets" after you run a build).
This is needlessly confusing and limiting, because webpack's view of the world doesn't match what the app author actually writes. Mostly this doesn't matter when people are using all the defaults, but if they wanted to customize (for example) the location of the generated chunks they can't escape the assets subdir.
This PR fixes this problem by setting webpack's
output.pathto the root of the (output) ember app (meaning the "./dist" subdir in a typical build), and making corresponding adjustments tooutput.filenameandoutput.chunkFileNameso that we're still producing the same files by default, but they're now addressed relative to the whole app.This is fix for #1157.